/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.service;

import java.util.Vector;
/** This is a class which allows you to track the status of completion of a
    task 
    @author Shrideep Pallickara
    $Date$
    $Revision$
*/

public class Task {
  
  public static final int NOT_STARTED = 1;

  public static final int IN_PROGRESS = 2;

  public static final int COMPLETED = 3;

  private int status;

  private long taskId;
  
  private String description;

  private int numOfSubTasks;

  private int numOfSubTasksCompleted;

  private int numOfWorkUnits;

  private int numOfWorkUnitsCompleted;

  private boolean hasSubTasks = false;

  private Vector subTasks;

  private String moduleName = "Task: ";

  public long getTaskId() {
    return taskId;
  }
  
  public String getTaskDescription() {
    return description;
  }
  
  public int getStatus() {
    if (!hasSubTasks)
      return status;

    for (int i=0; i < numOfSubTasks; i++) {
      Task subTask = getSubTask(i);
      if (subTask.getStatus() != COMPLETED) {
	return IN_PROGRESS;
      }
    }
    return COMPLETED;
  }

  public boolean hasSubTasks() {
    return hasSubTasks;
  }
  
  public int getNumOfSubTasks() {
    return numOfSubTasks;
  }
  
  /** The sub task numbering starts at 0 */
  public Task getSubTask(int subTaskNum) {
    return (Task) subTasks.elementAt(subTaskNum);
  }
  

  public int getNumOfWorkUnits() {
    return numOfWorkUnits;
  }

  
  public int getNumOfWorkUnitsCompleted() {
    return numOfWorkUnitsCompleted;
  }
  
  
  protected Task(long taskId) {
    this.taskId = taskId;
    status = NOT_STARTED;
  } 
  

  protected void addSubTask(Task subTask) {
    subTasks.addElement(subTask);
  }
  
  protected void setNumOfSubTasks(int numOfSubTasks) {
    this.hasSubTasks = true;
    this.numOfSubTasks = numOfSubTasks;
    subTasks = new Vector();
  }

	      
  protected void setTaskDescription(String description) {
    this.description = description;
  }
  


  protected void setNumOfWorkUnits(int numOfWorkUnits) {
    this.numOfWorkUnits = numOfWorkUnits;
  }

  

  protected void setNumOfWorkUnitsCompleted(int numOfWorkUnitsCompleted) {
    if (numOfWorkUnitsCompleted > numOfWorkUnits) {
      System.out.println(moduleName + "numOfWorkUnitsCompleted [" + 
			 numOfWorkUnitsCompleted + "] is GREATER THAN"
			 + " numOfWorkUnits[" + numOfWorkUnits + "]");
      return;
    }
    
    if (numOfWorkUnitsCompleted == 1) {
      status = IN_PROGRESS;
    }
    
    if (numOfWorkUnitsCompleted == numOfWorkUnits) {
      status = COMPLETED;
    }
    
    this.numOfWorkUnitsCompleted = numOfWorkUnitsCompleted;
  }
  
  public String toString() {
    String stringRep = "Task=" + taskId + "->" + description;
    
    if (hasSubTasks) {
      stringRep += (", Num Of SubTasks=" + numOfSubTasks + "\n");
      for (int i=0; i<numOfSubTasks; i++) {
	Task subTask = getSubTask(i);
	stringRep += (subTask.toString() + "\n") ;
      }
    } 

    stringRep += (":-> NumOfWorkUnits=" + numOfWorkUnits +
		  ", NumOfWorkUnitsCompleted=" + numOfWorkUnitsCompleted);
    return stringRep;
  }
  
}

